Remove a content item's tag
{ removeTagFromItem }
Removes the tag from a content item
Method
/API3/content/removeTagFromItem
- Enterprise Admin
Input Parameters
Name
tagUsageApiData
Object Type
Description
The tag usage object used to set a tag for a given content item.
Output Response
Successful Result Code
200
Response Type
Description of Response Type
Generic API response object with success or failure flag and related messages.
Examples
![Closed](../../../../../../../../Skins/Default/Stylesheets/Images/transparent.gif)
This example demonstrates how to find item's and the manipulation of content tags.
The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.
// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";
// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
"userName":"adminUser",
"password":"abc123!"
},"",false);
//step 2: add a tag to the system
let addedTag = callApi("content/addTag",{
"tagDescription":tagName,
"tagType":0
},token);
let tagId = addedTag.data.modifiedList[0].id;
//step 2: find/search for a Discover item called "sales figures"
let dataDiscovery = callApi("content/findContentItem",{
"searchString": "sales figures",
"filterTypes": [3],
"searchMatchType": 2,
"searchRootFolderType":0
},token // admin token generated above
);
let itemId = dataDiscovery.data[0].id;
//step 3: bind the new tag to this report
let itemIds = callApi("content/addTagToItem ",{
"itemId":itemId,
"tagId":tagId
},token);
//step 4: get a specific tag object using its tag id
let getTag = callApi("content/getTagData",tagId ,token)
//step 5: remove the tag from a specific content item
let removeTagFromItem = callApi("content/removeTagFromItem",{
"itemId":itemId,
"tagId":tagId
},token);
//step 6: delete the tag
let deleteTag = callApi("content/deleteTag",tagId, token);
//step 7: permanently delete the content item
let purgeContentItems = callApi("content/purgeContentItems",[folderCreation.modifiedList[0].id],token);
// ##### optional generic logging method for debugging ##############
function log(msg){
document.write(msg);
console.log(msg);
}
// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
var xhttp = new XMLHttpRequest();
xhttp.open("POST", pyramidURL+path, false);
xhttp.setRequestHeader("paToken",token)
xhttp.send(JSON.stringify(data));
if(parseResult){
return JSON.parse(xhttp.responseText);
}else{
return xhttp.responseText;
}
}
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/content/removeTagFromItem" \
-d '{
"itemId" : "itemId",
"tagId" : "tagId"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ContentServiceApi;
import java.util.*;
import java.time.*;
public class ContentServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
ContentServiceApi apiInstance = new ContentServiceApi();
// Initialize the tagUsageApiData parameter object for the call
TagUsageApiData tagUsageApiData = ; // Create the input object for the operation, type: TagUsageApiData
try {
ModifiedItemsResult result = apiInstance.removeTagFromItem(tagUsageApiData);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentServiceApi#removeTagFromItem");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ContentServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const tagUsageApiData = ; // {TagUsageApiData}
api.removeTagFromItem(tagUsageApiData).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class removeTagFromItemExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new ContentServiceApi();
// Initialize the tagUsageApiData parameter object for the call
var tagUsageApiData = new TagUsageApiData(); // TagUsageApiData |
try {
// Removes the tag from a content item
ModifiedItemsResult result = apiInstance.removeTagFromItem(tagUsageApiData);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ContentServiceApi.removeTagFromItem: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import ContentServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = ContentServiceApi(api_client)
# Initialize the tagUsageApiData parameter object for the call
tagUsageApiData = # TagUsageApiData |
try:
# Removes the tag from a content item
api_response = api_instance.remove_tag_from_item(tagUsageApiData)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentServiceApi->removeTagFromItem: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentServiceApi();
$tagUsageApiData = ; // TagUsageApiData |
try {
$result = $api_instance->removeTagFromItem($tagUsageApiData);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContentServiceApi->removeTagFromItem: ', $e->getMessage(), PHP_EOL;
}
?>